home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / hlpdk11.zip / HLPDK.DOC < prev    next >
Text File  |  1992-11-26  |  9KB  |  207 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. * HLPDK- Help Engine Dev. Kit : helpEng Doc V1.1                              *
  13. * LAST UPDATE - Nov. 26, 1992. (c) 1992 - Loewy Ron.                          *
  14. *******************************************************************************
  15.  
  16.  
  17.  
  18.         RL Help Engine.
  19.         
  20.         Help Compiler, Run-Time help engine and docs.
  21.  
  22.         Support for Dos & Windows.
  23.  
  24.                    
  25. *******************************************************************************
  26. *                                  File-List                                  *
  27. *******************************************************************************
  28.  
  29.  This package contains the following files :
  30.  
  31.  HELPENG.EXE    - Help Engine.
  32.  HELPC.EXE      - Help Compiler.
  33.  HLPDK.DOC      - This file.
  34.  HELPC.DOC      - Help Compiler documentation
  35.  HELPDEMO.HDF   - Demo Help Project.
  36.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  37.  PXENGINE.OVL   - Paradox Engine V2.0 Overlay file.
  38.  HLPDK.REG      - Registration file.
  39.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  40.  
  41. *******************************************************************************
  42. *                                Why Register                                 *
  43. *******************************************************************************
  44.  
  45.   The Help Engine Development Kit (HLPDK) is a shareware product, 
  46.  if you find this product valuable, please register it. 
  47.  This section describes the reasons you should register.
  48.  
  49.   By registering you will receive a printed manual, with complete discussion
  50.  of the help engine features, and many examples of usage. You will receive a 
  51.  diskette with the latest HEDK version.
  52.  
  53.   Your registration will help us to create the next versions of HEDK, that
  54.  will include more options, and features, some of them might even be your
  55.  enhancement requests!.
  56.  
  57.   A point to consider - If you want to create Windows Help source files,
  58.  you will have to purchase a word processor that can output RTF files,
  59.  the WORD for Windows 2.0 package, for example, is listed at around $500!.
  60.  
  61. *******************************************************************************
  62. *                                  What's New                                 *
  63. *******************************************************************************
  64.  
  65.         - The Help Engine ALT-X (EXIT) command restores the screen
  66.           upon termination.
  67.  
  68.         - Added /R switch for the helpC help compiler.
  69.  
  70.         - From this version the helpC compiler can generate source
  71.           files for the Microsoft help compiler (HC) from the
  72.           SAME source .HDF). If the /w+ switch is specified,
  73.           the helpC compiler will create a .HPJ and .RTF files
  74.           to create the Windows .HLP file.
  75.  
  76.         - Includes a compiled version of the help demo database for
  77.           Windows WINHELP program. (View this if you do not have the
  78.           Microsoft HC Windows Help Compiler, to see the output that
  79.           can be generated with the helpC compiler, as a source to the 
  80.           HC compiler.
  81.  
  82. *******************************************************************************
  83. *                                Introduction                                 *
  84. *******************************************************************************
  85.  
  86.   The Help Engine Development Kit is a system that allows you to create 
  87.  hyper-text database help systems with topics and hot links, using a simple
  88.  text editor and the help compiler. 
  89.  
  90.   The help databases can be distributed (free of charge) with the HELPENG
  91.  help engine display program. 
  92.  
  93.   If you own the Paradox Engine you can use the help databases with your
  94.  own programs. 
  95.  
  96.   The helpC compiler that is part of this development kit includes the
  97.  ability to create Windows Help source files from the same source the 
  98.  dos help sources are created!. Write your help once, and create help
  99.  databases for Dos and Windows!
  100.  
  101.   Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  102.  Turbo Pascal programs, and use the help engine window in your pascal
  103.  programs.
  104.  
  105. *******************************************************************************
  106. *                                    Setup                                    *
  107. *******************************************************************************
  108.  
  109.   Copy the files in this package to a directory of your choice.
  110.  
  111.   In order to use the HELPENG and HELPC programs the PXENGINE.OVL file
  112.  must be in the same directory.
  113.  
  114. *******************************************************************************
  115. *                                 Quick Start                                 *
  116. *******************************************************************************
  117.  
  118.   From the command line enter HELPC HELPDEMO to compile the demo help database.
  119.  
  120.   After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  121.  demo help database.
  122.  
  123.  If you want to compile for windows :
  124.  
  125.  from the command line enter HELPC HELPDEMO /W+
  126.  and after that HC HELPDEMO
  127.  (HC is the Microsoft Help Compiler)
  128.  from windows, open the HELPDEMO.HLP file from the windows help engine.
  129.  (Notice - if you do not have the HC help compiler from windows, we have
  130.   included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  131.   able to feel the quality of the output that can be generated, and decide
  132.   if you want to purchase the HC program. (Included with the SDK, BC++, TPW
  133.   and probably some other packages).
  134.  
  135. *******************************************************************************
  136. *                                  Operation                                  *
  137. *******************************************************************************
  138.  
  139.   To start the help engine program enter HELPENG on the command line, and 
  140.  choose the help database you want to view from the list box. Use the Tab key
  141.  to cycle between hot-link words, and press Enter to go to that link.
  142.  
  143.   To create a new help database please refer to the HELPC documentation
  144.  file.
  145.  
  146. *******************************************************************************
  147. *                                  Warranty                                   *
  148. *******************************************************************************
  149.  
  150.   There is no warranty what so ever, The package is supplied as is,
  151.  The distributor (ISoft D&M), or the author (Loewy Ron), are not, 
  152.  and will not be responsible for any damages, lost profits, 
  153.  or inconveniences caused by the use, or inability to use this package. 
  154.  The use of the program is at your own risk. 
  155.  By using (or attempting to use) the package you agree to this.
  156.  
  157. *******************************************************************************
  158. *                                   General                                   *
  159. *******************************************************************************
  160.  
  161.   HLPDK is distributed by ISoft D&M, P.O.B. 5517 CORALVILLE IA 52241, U.S.A.
  162.  
  163.   HLPDK is (c) copyrighted by Loewy Ron, 1992.
  164.  
  165.   HLPDK is a shareware program, please register your copy. 
  166.   To register your copy of HLPDK please refer to the supplied
  167.   HLPDK.REG file. 
  168.  
  169.   Other programs distributed by ISoft D&M are described in the supplied  
  170.   PROGRAMS.TXT file.
  171.  
  172.  
  173. *******************************************************************************
  174. *                                   Contact                                   *
  175. *******************************************************************************
  176.  
  177.   Please contact :
  178.  
  179.   ISoft D&M,  
  180.   P.O.B 5517
  181.   Coralville IA 52241,
  182.   U.S.A
  183.  
  184.   To contact the author directly : 
  185.  
  186.   Contact :     Loewy Ron,
  187.                 9 Haneveem st.
  188.                 Herzeliya, 46465
  189.                 ISRAEL.
  190.  
  191. *******************************************************************************
  192. *                                   History                                   *
  193. *******************************************************************************
  194.  
  195.  
  196.   Version 1.0 -         First Version, Written for TXS V3.0 help system, 
  197.                         and generalized.
  198.  
  199. *******************************************************************************
  200. *                                   Credits                                   *
  201. *******************************************************************************
  202.  
  203.   HELPENG, HELPC were written using Turbo-Pascal 6.0, Paradox Engine 2.0
  204.   (Copyright - Borland International).
  205.  
  206.   Windows, Microsoft, HC are a trademarks of Microsoft Corp.
  207.